doc: document host OS and Python support matrix - #520
Open
blackboxsw wants to merge 1 commit into
Open
Conversation
Add docs/supported_platforms.md documenting that pycloudlib runs on Linux only, with Ubuntu 24.04 LTS (Python 3.12) and Ubuntu 26.04 LTS (Python 3.14) as the tested host environments. Wire the new page into the docs index toctree and add a brief "Supported platforms" blurb to the README linking to it. The Ubuntu 26.04 LTS row is forward-looking: CI does not yet run on an ubuntu-26.04 runner and no py314 tox env exists yet. The documented minimum Python is 3.12, though pyproject.toml still declares requires-python = ">=3.8" so pip will permit install on older, untested versions. No code or package metadata changes; docs-only.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
To ease the process of reviewing your PR, do make sure to complete the following checklist before submitting a pull
request.
tox -e formatlocally to automatically format my code before submittingtox -e docslocally ensuring that it passes before submittingDescription
A followup to #508 to better document our python support matrix and host OS for test runners.
Add docs/supported_platforms.md documenting that pycloudlib runs on Linux only, with Ubuntu 24.04 LTS (Python 3.12) and Ubuntu 26.04 LTS (Python 3.14) as the tested host environments. Wire the new page into the docs index toctree and add a brief "Supported platforms" blurb to the README linking to it.
The Ubuntu 26.04 LTS row is forward-looking: CI does not yet run on an ubuntu-26.04 runner and no py314 tox env exists yet. The documented minimum Python is 3.12, though pyproject.toml still declares requires-python = ">=3.8" so pip will permit install on older, untested versions.
No code or package metadata changes; docs-only.
Additional Context and Relevant Issues
Test Steps
tox -e docs